You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Include a brief note on potential impacts on existing configurations in the summary
It's beneficial to include a brief explanation of how the new logic might affect existing configurations directly in the summary to alert users who might not expand the detailed view.
-<summary>Fixed an error in the calculation of effective rate limit from multiple policies</summary>+<summary>Fixed an error in the calculation of effective rate limit from multiple policies. This change may affect existing configurations by applying a different rate limit.</summary>
Suggestion importance[1-10]: 8
Why: Including a note about potential impacts directly in the summary is important for alerting users who might not read the detailed view, ensuring they are aware of changes that could affect their configurations.
8
Add a direct link to the detailed release notes or documentation for the bug fix
Consider adding a link to the specific release notes or documentation section that discusses the bug fix in more detail. This will provide readers with a direct reference to understand the changes and their implications fully.
{{< note success >}}
**Note**
-Prior to Tyk 5.4.0 there was a long-standing bug in the calculation of the effective rate limit applied to the key where Tyk would combine the highest `rate` and highest `per` from the policies applied to the key, so for the example above the key would have `rate` set to 100 and `per` set to 30 giving an effective rate limit of 3.33rps. This has now been corrected.+Prior to Tyk 5.4.0 there was a long-standing bug in the calculation of the effective rate limit applied to the key where Tyk would combine the highest `rate` and highest `per` from the policies applied to the key, so for the example above the key would have `rate` set to 100 and `per` set to 30 giving an effective rate limit of 3.33rps. This has now been corrected. For more details, see the [release notes](link-to-the-specific-release-notes).
{{< /note >}}
Suggestion importance[1-10]: 7
Why: Adding a direct link to the release notes enhances the documentation by providing readers with easy access to more detailed information, improving user experience and understanding.
7
User guidance
Mention backward compatibility and provide user guidance for configuration review upon upgrading
To avoid potential confusion, explicitly mention that the change is backward compatible or provide guidance on what steps, if any, users should take when upgrading.
-Note that this corrected logic is applied when access keys are presented in API requests. If you are applying multiple policies to keys, there may be a change in the effective rate limit when using Tyk 5.4.0 compared with pre-5.4.0 versions.+Note that this corrected logic is applied when access keys are presented in API requests and is backward compatible. Users applying multiple policies to keys should review their configurations to ensure desired operation under the new logic. There may be a change in the effective rate limit when using Tyk 5.4.0 compared with pre-5.4.0 versions.
Suggestion importance[1-10]: 7
Why: Providing guidance on backward compatibility and advising users to review configurations is valuable for ensuring smooth transitions and preventing potential issues during upgrades.
7
Clarity
Clarify the explanation of how the highest effective rate limit is now applied
To enhance clarity, consider rephrasing to explicitly state that the highest effective rate limit is now correctly applied, avoiding the previous error of combining the highest rate and per values incorrectly.
-With the fix applied in Tyk 5.4.0, the Gateway will now apply the highest effective rate to the key - so in this example, the key would take the rate limit from policy B: `rate = 100` and `per = 10` (10rps).+With the fix applied in Tyk 5.4.0, the Gateway now correctly applies the highest effective rate limit. For example, if policy A has a rate limit of 3rps and policy B has 10rps, the key will use the 10rps from policy B, avoiding the previous error of incorrectly combining the highest `rate` and `per` values.
Suggestion importance[1-10]: 6
Why: The suggestion improves clarity by explicitly stating the correct application of the highest effective rate limit, which helps prevent misunderstandings about the changes made.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
[TT-12840, DX-1620] Added explanation of bug fix missed in 5.4 RN (#5260)
PR Type
documentation, enhancement
Description
Changes walkthrough 📝
rate-limiting.md
Documented changes in rate limit calculation with multiple policies
tyk-docs/content/getting-started/key-concepts/rate-limiting.md
rate limits.
limits.
version-5.4.md
Updated release notes with rate limit calculation fix
tyk-docs/content/product-stack/tyk-gateway/release-notes/version-5.4.md
determination.